
<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
      
      
      
        <link rel="prev" href="../ssms/">
      
      
        <link rel="next" href="../config/">
      
      
      <link rel="icon" href="../../assets/images/favicon.png">
      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.0">
    
    
      
        <title>basic simulators - SSMS (Sequential Sampling Model Simulators)</title>
      
    
    
      <link rel="stylesheet" href="../../assets/stylesheets/main.45e1311d.min.css">
      
        
        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
      
      


    
    
      
    
    
      
        
        
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
      
    
    
      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
    
    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
    
      

    
    
    
  </head>
  
  
    
    
      
    
    
    
    
    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#ssms.basic_simulators" class="md-skip">
          Skip to content
        </a>
      
    </div>
    <div data-md-component="announce">
      
        <aside class="md-banner">
          <div class="md-banner__inner md-grid md-typeset">
            
              <button class="md-banner__button md-icon" aria-label="Don't show this again">
                
                <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
              </button>
            
            
<span class="show-on-small right-margin">
    <span class="twemoji right-margin show-on-small move-down">
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M246.6 470.6c-12.5 12.5-32.8 12.5-45.3 0l-160-160c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L224 402.7l137.4-137.3c12.5-12.5 32.8-12.5 45.3 0s12.5 32.8 0 45.3l-160 160zm160-352-160 160c-12.5 12.5-32.8 12.5-45.3 0l-160-160c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L224 210.7 361.4 73.4c12.5-12.5 32.8-12.5 45.3 0s12.5 32.8 0 45.3z"/></svg>
    </span>
    Navigate the site here!
</span>
<span class="right-margin">
    v0.6.1 is out!
</span>
<span>
    <span class="twemoji">
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 3C9.23 3 6.19 5.95 6 9.66l-1.92 2.53c-.24.31 0 .81.42.81H6v3c0 1.11.89 2 2 2h1v3h7v-4.69c2.37-1.12 4-3.51 4-6.31 0-3.86-3.12-7-7-7m1 11h-2v-2h2v2m1.75-5.19c-.29.4-.66.69-1.11.93-.25.16-.42.33-.51.52-.09.18-.13.43-.13.74h-2c0-.5.11-.92.31-1.18.19-.27.54-.57 1.05-.91.26-.16.47-.36.61-.59.16-.23.23-.5.23-.82 0-.3-.08-.56-.26-.75-.18-.18-.44-.28-.75-.28a1 1 0 0 0-.66.23c-.18.16-.27.39-.28.69h-1.93l-.01-.03c-.01-.79.25-1.36.77-1.77.54-.39 1.24-.59 2.11-.59.93 0 1.66.23 2.19.68.54.45.81 1.06.81 1.82 0 .5-.15.91-.44 1.31Z"/></svg>
    </span>
</span>

          </div>
          
            <script>var content,el=document.querySelector("[data-md-component=announce]");el&&(content=el.querySelector(".md-typeset"),__md_hash(content.innerHTML)===__md_get("__announce")&&(el.hidden=!0))</script>
          
        </aside>
      
    </div>
    
    
      

  

<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="https://AlexanderFengler.github.io/ssm-simulators/" title="SSMS (Sequential Sampling Model Simulators)" class="md-header__button md-logo" aria-label="SSMS (Sequential Sampling Model Simulators)" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            SSMS (Sequential Sampling Model Simulators)
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              basic simulators
            
          </span>
        </div>
      </div>
    </div>
    
      
        <form class="md-header__option" data-md-component="palette">
  
    
    
    
    <input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to dark mode"  type="radio" name="__palette" id="__palette_0">
    
      <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9h-1.9M20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69m-9.15 3.96h2.3L12 9l-1.15 3.65Z"/></svg>
      </label>
    
  
    
    
    
    <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_1">
    
      <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_2" hidden>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
      </label>
    
  
    
    
    
    <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to automatic mode"  type="radio" name="__palette" id="__palette_2">
    
      <label class="md-header__button md-icon" title="Switch to automatic mode" for="__palette_0" hidden>
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
      </label>
    
  
</form>
      
    
    
      <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
    
    
    
      <label class="md-header__button md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
      </label>
      <div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
      <label class="md-search__icon md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        
        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
        </button>
      </nav>
      
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list" role="presentation"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
    
    
      <div class="md-header__source">
        <a href="htps://github.com/AlexanderFengler/ssm-simulators" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  </div>
  <div class="md-source__repository">
    AlexanderFengler/ssm-simulators
  </div>
</a>
      </div>
    
  </nav>
  
    
      
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  <div class="md-grid">
    <ul class="md-tabs__list">
      
        
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../.." class="md-tabs__link">
          
  
  Home

        </a>
      </li>
    
  

      
        
  
  
  
    
    
      <li class="md-tabs__item">
        <a href="../../basic_tutorial/basic_tutorial/" class="md-tabs__link">
          
  
  Basic Tutorial

        </a>
      </li>
    
  

      
        
  
  
    
  
  
    
    
      <li class="md-tabs__item md-tabs__item--active">
        <a href="../ssms/" class="md-tabs__link">
          
  
  API

        </a>
      </li>
    
  

      
    </ul>
  </div>
</nav>
    
  
</header>
    
    <div class="md-container" data-md-component="container">
      
      
        
      
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    


  


<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="https://AlexanderFengler.github.io/ssm-simulators/" title="SSMS (Sequential Sampling Model Simulators)" class="md-nav__button md-logo" aria-label="SSMS (Sequential Sampling Model Simulators)" data-md-component="logo">
      
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

    </a>
    SSMS (Sequential Sampling Model Simulators)
  </label>
  
    <div class="md-nav__source">
      <a href="htps://github.com/AlexanderFengler/ssm-simulators" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
  </div>
  <div class="md-source__repository">
    AlexanderFengler/ssm-simulators
  </div>
</a>
    </div>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
      
  
  
  
  
    
    
    
    
    
      
      
    
    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
        
          
          <label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Home
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_1">
            <span class="md-nav__icon md-icon"></span>
            Home
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../.." class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Overview
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
    
      
      
    
    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
        
          
          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Basic Tutorial
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_2">
            <span class="md-nav__icon md-icon"></span>
            Basic Tutorial
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../basic_tutorial/basic_tutorial/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Installation
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
    
  
  
  
    
    
    
    
    
      
      
    
    <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
      
        
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
        
          
          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
            
  
  <span class="md-ellipsis">
    API
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
          <label class="md-nav__title" for="__nav_3">
            <span class="md-nav__icon md-icon"></span>
            API
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../ssms/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ssms
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
    
  
  
  
    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
      
      
      
        <label class="md-nav__link md-nav__link--active" for="__toc">
          
  
  <span class="md-ellipsis">
    basic simulators
  </span>
  

          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="./" class="md-nav__link md-nav__link--active">
        
  
  <span class="md-ellipsis">
    basic simulators
  </span>
  

      </a>
      
        

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#ssms.basic_simulators" class="md-nav__link">
    <span class="md-ellipsis">
      ssms.basic_simulators
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions" class="md-nav__link">
    <span class="md-ellipsis">
      boundary_functions
    </span>
  </a>
  
    <nav class="md-nav" aria-label="boundary_functions">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.angle" class="md-nav__link">
    <span class="md-ellipsis">
      angle()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="angle()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.angle--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.angle--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.conflict_gamma_bound" class="md-nav__link">
    <span class="md-ellipsis">
      conflict_gamma_bound()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="conflict_gamma_bound()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.conflict_gamma_bound--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.conflict_gamma_bound--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.constant" class="md-nav__link">
    <span class="md-ellipsis">
      constant()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="constant()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.constant--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.constant--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.generalized_logistic_bnd" class="md-nav__link">
    <span class="md-ellipsis">
      generalized_logistic_bnd()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="generalized_logistic_bnd()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.generalized_logistic_bnd--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.generalized_logistic_bnd--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.weibull_cdf" class="md-nav__link">
    <span class="md-ellipsis">
      weibull_cdf()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="weibull_cdf()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.weibull_cdf--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.weibull_cdf--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions" class="md-nav__link">
    <span class="md-ellipsis">
      drift_functions
    </span>
  </a>
  
    <nav class="md-nav" aria-label="drift_functions">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.constant" class="md-nav__link">
    <span class="md-ellipsis">
      constant()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="constant()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.constant--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.constant--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_conflict_drift" class="md-nav__link">
    <span class="md-ellipsis">
      ds_conflict_drift()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="ds_conflict_drift()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_conflict_drift--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_conflict_drift--return" class="md-nav__link">
    <span class="md-ellipsis">
      Return
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_support_analytic" class="md-nav__link">
    <span class="md-ellipsis">
      ds_support_analytic()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="ds_support_analytic()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_support_analytic--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_support_analytic--return" class="md-nav__link">
    <span class="md-ellipsis">
      Return
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.gamma_drift" class="md-nav__link">
    <span class="md-ellipsis">
      gamma_drift()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="gamma_drift()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.gamma_drift--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.gamma_drift--return" class="md-nav__link">
    <span class="md-ellipsis">
      Return
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator" class="md-nav__link">
    <span class="md-ellipsis">
      simulator
    </span>
  </a>
  
    <nav class="md-nav" aria-label="simulator">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_arbitrary_fptd" class="md-nav__link">
    <span class="md-ellipsis">
      bin_arbitrary_fptd()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="bin_arbitrary_fptd()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_arbitrary_fptd--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output" class="md-nav__link">
    <span class="md-ellipsis">
      bin_simulator_output()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="bin_simulator_output()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output_pointwise" class="md-nav__link">
    <span class="md-ellipsis">
      bin_simulator_output_pointwise()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="bin_simulator_output_pointwise()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output_pointwise--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output_pointwise--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.simulator" class="md-nav__link">
    <span class="md-ellipsis">
      simulator()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="simulator()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.simulator--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.simulator--return" class="md-nav__link">
    <span class="md-ellipsis">
      Return
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../config/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    config
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../dataset_generators/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    data generators
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#ssms.basic_simulators" class="md-nav__link">
    <span class="md-ellipsis">
      ssms.basic_simulators
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions" class="md-nav__link">
    <span class="md-ellipsis">
      boundary_functions
    </span>
  </a>
  
    <nav class="md-nav" aria-label="boundary_functions">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.angle" class="md-nav__link">
    <span class="md-ellipsis">
      angle()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="angle()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.angle--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.angle--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.conflict_gamma_bound" class="md-nav__link">
    <span class="md-ellipsis">
      conflict_gamma_bound()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="conflict_gamma_bound()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.conflict_gamma_bound--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.conflict_gamma_bound--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.constant" class="md-nav__link">
    <span class="md-ellipsis">
      constant()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="constant()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.constant--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.constant--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.generalized_logistic_bnd" class="md-nav__link">
    <span class="md-ellipsis">
      generalized_logistic_bnd()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="generalized_logistic_bnd()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.generalized_logistic_bnd--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.generalized_logistic_bnd--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.weibull_cdf" class="md-nav__link">
    <span class="md-ellipsis">
      weibull_cdf()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="weibull_cdf()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.weibull_cdf--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.boundary_functions.weibull_cdf--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions" class="md-nav__link">
    <span class="md-ellipsis">
      drift_functions
    </span>
  </a>
  
    <nav class="md-nav" aria-label="drift_functions">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.constant" class="md-nav__link">
    <span class="md-ellipsis">
      constant()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="constant()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.constant--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.constant--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_conflict_drift" class="md-nav__link">
    <span class="md-ellipsis">
      ds_conflict_drift()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="ds_conflict_drift()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_conflict_drift--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_conflict_drift--return" class="md-nav__link">
    <span class="md-ellipsis">
      Return
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_support_analytic" class="md-nav__link">
    <span class="md-ellipsis">
      ds_support_analytic()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="ds_support_analytic()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_support_analytic--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.ds_support_analytic--return" class="md-nav__link">
    <span class="md-ellipsis">
      Return
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.gamma_drift" class="md-nav__link">
    <span class="md-ellipsis">
      gamma_drift()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="gamma_drift()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.gamma_drift--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.drift_functions.gamma_drift--return" class="md-nav__link">
    <span class="md-ellipsis">
      Return
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator" class="md-nav__link">
    <span class="md-ellipsis">
      simulator
    </span>
  </a>
  
    <nav class="md-nav" aria-label="simulator">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_arbitrary_fptd" class="md-nav__link">
    <span class="md-ellipsis">
      bin_arbitrary_fptd()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="bin_arbitrary_fptd()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_arbitrary_fptd--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output" class="md-nav__link">
    <span class="md-ellipsis">
      bin_simulator_output()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="bin_simulator_output()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output_pointwise" class="md-nav__link">
    <span class="md-ellipsis">
      bin_simulator_output_pointwise()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="bin_simulator_output_pointwise()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output_pointwise--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.bin_simulator_output_pointwise--returns" class="md-nav__link">
    <span class="md-ellipsis">
      Returns
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.simulator" class="md-nav__link">
    <span class="md-ellipsis">
      simulator()
    </span>
  </a>
  
    <nav class="md-nav" aria-label="simulator()">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.simulator--arguments" class="md-nav__link">
    <span class="md-ellipsis">
      Arguments
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#ssms.basic_simulators.simulator.simulator--return" class="md-nav__link">
    <span class="md-ellipsis">
      Return
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  

  
    <a href="edit/main/docs/api/basic_simulators.md" title="Edit this page" class="md-content__button md-icon">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4v-2m10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1 2.1 2.1Z"/></svg>
    </a>
  
  
    
      
    
    <a href="raw/main/docs/api/basic_simulators.md" title="View source of this page" class="md-content__button md-icon">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.15 8.15 0 0 1-1.23-2Z"/></svg>
    </a>
  


  <h1>basic simulators</h1>

<div class="doc doc-object doc-module">

<a id="ssms.basic_simulators"></a>
    <div class="doc doc-contents first">




  <div class="doc doc-children">







  <div class="doc doc-object doc-module">



<h2 id="ssms.basic_simulators.boundary_functions" class="doc doc-heading">
        <code>boundary_functions</code>



</h2>

    <div class="doc doc-contents ">




  <div class="doc doc-children">




  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.boundary_functions.angle" class="doc doc-heading">
<code class="highlight language-python"><span class="n">angle</span><span class="p">(</span><span class="n">t</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">theta</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>angle boundary function</p>
<h5 id="ssms.basic_simulators.boundary_functions.angle--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>t (int, optional): _description_. Defaults to 1.
theta (int, optional): _description_. Defaults to 1.
</code></pre></div>
<h5 id="ssms.basic_simulators.boundary_functions.angle--returns">Returns</h5>
<div class="language-text highlight"><pre><span></span><code>np.array: Array of boundary values, same length as t
</code></pre></div>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.boundary_functions.conflict_gamma_bound" class="doc doc-heading">
<code class="highlight language-python"><span class="n">conflict_gamma_bound</span><span class="p">(</span><span class="n">t</span><span class="o">=</span><span class="n">array</span><span class="p">([</span> <span class="mf">0.</span> <span class="p">,</span>  <span class="mf">0.1</span><span class="p">,</span>  <span class="mf">0.2</span><span class="p">,</span>  <span class="mf">0.3</span><span class="p">,</span>  <span class="mf">0.4</span><span class="p">,</span>  <span class="mf">0.5</span><span class="p">,</span>  <span class="mf">0.6</span><span class="p">,</span>  <span class="mf">0.7</span><span class="p">,</span>  <span class="mf">0.8</span><span class="p">,</span>  <span class="mf">0.9</span><span class="p">,</span>  <span class="mf">1.</span> <span class="p">,</span><span class="mf">1.1</span><span class="p">,</span>  <span class="mf">1.2</span><span class="p">,</span>  <span class="mf">1.3</span><span class="p">,</span>  <span class="mf">1.4</span><span class="p">,</span>  <span class="mf">1.5</span><span class="p">,</span>  <span class="mf">1.6</span><span class="p">,</span>  <span class="mf">1.7</span><span class="p">,</span>  <span class="mf">1.8</span><span class="p">,</span>  <span class="mf">1.9</span><span class="p">,</span>  <span class="mf">2.</span> <span class="p">,</span>  <span class="mf">2.1</span><span class="p">,</span><span class="mf">2.2</span><span class="p">,</span>  <span class="mf">2.3</span><span class="p">,</span>  <span class="mf">2.4</span><span class="p">,</span>  <span class="mf">2.5</span><span class="p">,</span>  <span class="mf">2.6</span><span class="p">,</span>  <span class="mf">2.7</span><span class="p">,</span>  <span class="mf">2.8</span><span class="p">,</span>  <span class="mf">2.9</span><span class="p">,</span>  <span class="mf">3.</span> <span class="p">,</span>  <span class="mf">3.1</span><span class="p">,</span>  <span class="mf">3.2</span><span class="p">,</span><span class="mf">3.3</span><span class="p">,</span>  <span class="mf">3.4</span><span class="p">,</span>  <span class="mf">3.5</span><span class="p">,</span>  <span class="mf">3.6</span><span class="p">,</span>  <span class="mf">3.7</span><span class="p">,</span>  <span class="mf">3.8</span><span class="p">,</span>  <span class="mf">3.9</span><span class="p">,</span>  <span class="mf">4.</span> <span class="p">,</span>  <span class="mf">4.1</span><span class="p">,</span>  <span class="mf">4.2</span><span class="p">,</span>  <span class="mf">4.3</span><span class="p">,</span><span class="mf">4.4</span><span class="p">,</span>  <span class="mf">4.5</span><span class="p">,</span>  <span class="mf">4.6</span><span class="p">,</span>  <span class="mf">4.7</span><span class="p">,</span>  <span class="mf">4.8</span><span class="p">,</span>  <span class="mf">4.9</span><span class="p">,</span>  <span class="mf">5.</span> <span class="p">,</span>  <span class="mf">5.1</span><span class="p">,</span>  <span class="mf">5.2</span><span class="p">,</span>  <span class="mf">5.3</span><span class="p">,</span>  <span class="mf">5.4</span><span class="p">,</span><span class="mf">5.5</span><span class="p">,</span>  <span class="mf">5.6</span><span class="p">,</span>  <span class="mf">5.7</span><span class="p">,</span>  <span class="mf">5.8</span><span class="p">,</span>  <span class="mf">5.9</span><span class="p">,</span>  <span class="mf">6.</span> <span class="p">,</span>  <span class="mf">6.1</span><span class="p">,</span>  <span class="mf">6.2</span><span class="p">,</span>  <span class="mf">6.3</span><span class="p">,</span>  <span class="mf">6.4</span><span class="p">,</span>  <span class="mf">6.5</span><span class="p">,</span><span class="mf">6.6</span><span class="p">,</span>  <span class="mf">6.7</span><span class="p">,</span>  <span class="mf">6.8</span><span class="p">,</span>  <span class="mf">6.9</span><span class="p">,</span>  <span class="mf">7.</span> <span class="p">,</span>  <span class="mf">7.1</span><span class="p">,</span>  <span class="mf">7.2</span><span class="p">,</span>  <span class="mf">7.3</span><span class="p">,</span>  <span class="mf">7.4</span><span class="p">,</span>  <span class="mf">7.5</span><span class="p">,</span>  <span class="mf">7.6</span><span class="p">,</span><span class="mf">7.7</span><span class="p">,</span>  <span class="mf">7.8</span><span class="p">,</span>  <span class="mf">7.9</span><span class="p">,</span>  <span class="mf">8.</span> <span class="p">,</span>  <span class="mf">8.1</span><span class="p">,</span>  <span class="mf">8.2</span><span class="p">,</span>  <span class="mf">8.3</span><span class="p">,</span>  <span class="mf">8.4</span><span class="p">,</span>  <span class="mf">8.5</span><span class="p">,</span>  <span class="mf">8.6</span><span class="p">,</span>  <span class="mf">8.7</span><span class="p">,</span><span class="mf">8.8</span><span class="p">,</span>  <span class="mf">8.9</span><span class="p">,</span>  <span class="mf">9.</span> <span class="p">,</span>  <span class="mf">9.1</span><span class="p">,</span>  <span class="mf">9.2</span><span class="p">,</span>  <span class="mf">9.3</span><span class="p">,</span>  <span class="mf">9.4</span><span class="p">,</span>  <span class="mf">9.5</span><span class="p">,</span>  <span class="mf">9.6</span><span class="p">,</span>  <span class="mf">9.7</span><span class="p">,</span>  <span class="mf">9.8</span><span class="p">,</span><span class="mf">9.9</span><span class="p">,</span> <span class="mf">10.</span> <span class="p">,</span> <span class="mf">10.1</span><span class="p">,</span> <span class="mf">10.2</span><span class="p">,</span> <span class="mf">10.3</span><span class="p">,</span> <span class="mf">10.4</span><span class="p">,</span> <span class="mf">10.5</span><span class="p">,</span> <span class="mf">10.6</span><span class="p">,</span> <span class="mf">10.7</span><span class="p">,</span> <span class="mf">10.8</span><span class="p">,</span> <span class="mf">10.9</span><span class="p">,</span><span class="mf">11.</span> <span class="p">,</span> <span class="mf">11.1</span><span class="p">,</span> <span class="mf">11.2</span><span class="p">,</span> <span class="mf">11.3</span><span class="p">,</span> <span class="mf">11.4</span><span class="p">,</span> <span class="mf">11.5</span><span class="p">,</span> <span class="mf">11.6</span><span class="p">,</span> <span class="mf">11.7</span><span class="p">,</span> <span class="mf">11.8</span><span class="p">,</span> <span class="mf">11.9</span><span class="p">,</span> <span class="mf">12.</span> <span class="p">,</span><span class="mf">12.1</span><span class="p">,</span> <span class="mf">12.2</span><span class="p">,</span> <span class="mf">12.3</span><span class="p">,</span> <span class="mf">12.4</span><span class="p">,</span> <span class="mf">12.5</span><span class="p">,</span> <span class="mf">12.6</span><span class="p">,</span> <span class="mf">12.7</span><span class="p">,</span> <span class="mf">12.8</span><span class="p">,</span> <span class="mf">12.9</span><span class="p">,</span> <span class="mf">13.</span> <span class="p">,</span> <span class="mf">13.1</span><span class="p">,</span><span class="mf">13.2</span><span class="p">,</span> <span class="mf">13.3</span><span class="p">,</span> <span class="mf">13.4</span><span class="p">,</span> <span class="mf">13.5</span><span class="p">,</span> <span class="mf">13.6</span><span class="p">,</span> <span class="mf">13.7</span><span class="p">,</span> <span class="mf">13.8</span><span class="p">,</span> <span class="mf">13.9</span><span class="p">,</span> <span class="mf">14.</span> <span class="p">,</span> <span class="mf">14.1</span><span class="p">,</span> <span class="mf">14.2</span><span class="p">,</span><span class="mf">14.3</span><span class="p">,</span> <span class="mf">14.4</span><span class="p">,</span> <span class="mf">14.5</span><span class="p">,</span> <span class="mf">14.6</span><span class="p">,</span> <span class="mf">14.7</span><span class="p">,</span> <span class="mf">14.8</span><span class="p">,</span> <span class="mf">14.9</span><span class="p">,</span> <span class="mf">15.</span> <span class="p">,</span> <span class="mf">15.1</span><span class="p">,</span> <span class="mf">15.2</span><span class="p">,</span> <span class="mf">15.3</span><span class="p">,</span><span class="mf">15.4</span><span class="p">,</span> <span class="mf">15.5</span><span class="p">,</span> <span class="mf">15.6</span><span class="p">,</span> <span class="mf">15.7</span><span class="p">,</span> <span class="mf">15.8</span><span class="p">,</span> <span class="mf">15.9</span><span class="p">,</span> <span class="mf">16.</span> <span class="p">,</span> <span class="mf">16.1</span><span class="p">,</span> <span class="mf">16.2</span><span class="p">,</span> <span class="mf">16.3</span><span class="p">,</span> <span class="mf">16.4</span><span class="p">,</span><span class="mf">16.5</span><span class="p">,</span> <span class="mf">16.6</span><span class="p">,</span> <span class="mf">16.7</span><span class="p">,</span> <span class="mf">16.8</span><span class="p">,</span> <span class="mf">16.9</span><span class="p">,</span> <span class="mf">17.</span> <span class="p">,</span> <span class="mf">17.1</span><span class="p">,</span> <span class="mf">17.2</span><span class="p">,</span> <span class="mf">17.3</span><span class="p">,</span> <span class="mf">17.4</span><span class="p">,</span> <span class="mf">17.5</span><span class="p">,</span><span class="mf">17.6</span><span class="p">,</span> <span class="mf">17.7</span><span class="p">,</span> <span class="mf">17.8</span><span class="p">,</span> <span class="mf">17.9</span><span class="p">,</span> <span class="mf">18.</span> <span class="p">,</span> <span class="mf">18.1</span><span class="p">,</span> <span class="mf">18.2</span><span class="p">,</span> <span class="mf">18.3</span><span class="p">,</span> <span class="mf">18.4</span><span class="p">,</span> <span class="mf">18.5</span><span class="p">,</span> <span class="mf">18.6</span><span class="p">,</span><span class="mf">18.7</span><span class="p">,</span> <span class="mf">18.8</span><span class="p">,</span> <span class="mf">18.9</span><span class="p">,</span> <span class="mf">19.</span> <span class="p">,</span> <span class="mf">19.1</span><span class="p">,</span> <span class="mf">19.2</span><span class="p">,</span> <span class="mf">19.3</span><span class="p">,</span> <span class="mf">19.4</span><span class="p">,</span> <span class="mf">19.5</span><span class="p">,</span> <span class="mf">19.6</span><span class="p">,</span> <span class="mf">19.7</span><span class="p">,</span><span class="mf">19.8</span><span class="p">,</span> <span class="mf">19.9</span><span class="p">]),</span> <span class="n">a</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span> <span class="n">theta</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">alpha_gamma</span><span class="o">=</span><span class="mf">1.01</span><span class="p">,</span> <span class="n">scale_gamma</span><span class="o">=</span><span class="mf">0.3</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>conflict bound that allows initial divergence then collapse</p>
<h5 id="ssms.basic_simulators.boundary_functions.conflict_gamma_bound--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>!!! t &quot;np.array or float &lt;default = 1&gt;&quot;
    Time/s (with arbitrary measure, but in HDDM it is used as seconds),
    at which to evaluate the bound.
!!! theta &quot;float &lt;default = 0.5&gt;&quot;
    Collapse angle
!!! scale &quot;float &lt;default = 1.0&gt;&quot;
    Scaling the gamma distribution of the boundary
    (since bound does not have to integrate to one)
!!! a &quot;float &lt;default = 0.5&gt;&quot;
    Initial boundary separation
!!! alpha_gamma &quot;float &lt;default = 1.01&gt;&quot;
    alpha parameter for a gamma in scale shape parameterization
!!! scale_gamma &quot;float &lt;default = 0.3&gt;&quot;
    scale parameter for a gamma in scale shape paraemterization
</code></pre></div>
<h5 id="ssms.basic_simulators.boundary_functions.conflict_gamma_bound--returns">Returns</h5>
<div class="language-text highlight"><pre><span></span><code>np.array: Array of boundary values, same length as t
</code></pre></div>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.boundary_functions.constant" class="doc doc-heading">
<code class="highlight language-python"><span class="n">constant</span><span class="p">(</span><span class="n">t</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>constant boundary function</p>
<h5 id="ssms.basic_simulators.boundary_functions.constant--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>t (int, optional): _description_. Defaults to 0.
</code></pre></div>
<h5 id="ssms.basic_simulators.boundary_functions.constant--returns">Returns</h5>
<div class="language-text highlight"><pre><span></span><code>np.array: Array of boundary values, same length as t
</code></pre></div>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.boundary_functions.generalized_logistic_bnd" class="doc doc-heading">
<code class="highlight language-python"><span class="n">generalized_logistic_bnd</span><span class="p">(</span><span class="n">t</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">B</span><span class="o">=</span><span class="mf">2.0</span><span class="p">,</span> <span class="n">M</span><span class="o">=</span><span class="mf">3.0</span><span class="p">,</span> <span class="n">v</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>generalized logistic bound</p>
<h5 id="ssms.basic_simulators.boundary_functions.generalized_logistic_bnd--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>t (int, optional): Defaults to 1.
B (float, optional): Defaults to 2.0.
M (float, optional): Defaults to 3.0.
v (float, optional): Defaults to 0.5.
</code></pre></div>
<h5 id="ssms.basic_simulators.boundary_functions.generalized_logistic_bnd--returns">Returns</h5>
<div class="language-text highlight"><pre><span></span><code>np.array: Array of boundary values, same length as t
</code></pre></div>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.boundary_functions.weibull_cdf" class="doc doc-heading">
<code class="highlight language-python"><span class="n">weibull_cdf</span><span class="p">(</span><span class="n">t</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">beta</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>boundary based on weibull survival function.</p>
<h5 id="ssms.basic_simulators.boundary_functions.weibull_cdf--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>t (int, optional): Defaults to 1.
alpha (int, optional): Defaults to 1.
beta (int, optional): Defaults to 1.
</code></pre></div>
<h5 id="ssms.basic_simulators.boundary_functions.weibull_cdf--returns">Returns</h5>
<div class="language-text highlight"><pre><span></span><code>np.array: Array of boundary values, same length as t
</code></pre></div>

    </div>

  </div>





  </div>

    </div>

  </div>





  <div class="doc doc-object doc-module">



<h2 id="ssms.basic_simulators.drift_functions" class="doc doc-heading">
        <code>drift_functions</code>



</h2>

    <div class="doc doc-contents ">




  <div class="doc doc-children">




  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.drift_functions.constant" class="doc doc-heading">
<code class="highlight language-python"><span class="n">constant</span><span class="p">(</span><span class="n">t</span><span class="o">=</span><span class="n">array</span><span class="p">([</span> <span class="mf">0.</span> <span class="p">,</span>  <span class="mf">0.1</span><span class="p">,</span>  <span class="mf">0.2</span><span class="p">,</span>  <span class="mf">0.3</span><span class="p">,</span>  <span class="mf">0.4</span><span class="p">,</span>  <span class="mf">0.5</span><span class="p">,</span>  <span class="mf">0.6</span><span class="p">,</span>  <span class="mf">0.7</span><span class="p">,</span>  <span class="mf">0.8</span><span class="p">,</span>  <span class="mf">0.9</span><span class="p">,</span>  <span class="mf">1.</span> <span class="p">,</span><span class="mf">1.1</span><span class="p">,</span>  <span class="mf">1.2</span><span class="p">,</span>  <span class="mf">1.3</span><span class="p">,</span>  <span class="mf">1.4</span><span class="p">,</span>  <span class="mf">1.5</span><span class="p">,</span>  <span class="mf">1.6</span><span class="p">,</span>  <span class="mf">1.7</span><span class="p">,</span>  <span class="mf">1.8</span><span class="p">,</span>  <span class="mf">1.9</span><span class="p">,</span>  <span class="mf">2.</span> <span class="p">,</span>  <span class="mf">2.1</span><span class="p">,</span><span class="mf">2.2</span><span class="p">,</span>  <span class="mf">2.3</span><span class="p">,</span>  <span class="mf">2.4</span><span class="p">,</span>  <span class="mf">2.5</span><span class="p">,</span>  <span class="mf">2.6</span><span class="p">,</span>  <span class="mf">2.7</span><span class="p">,</span>  <span class="mf">2.8</span><span class="p">,</span>  <span class="mf">2.9</span><span class="p">,</span>  <span class="mf">3.</span> <span class="p">,</span>  <span class="mf">3.1</span><span class="p">,</span>  <span class="mf">3.2</span><span class="p">,</span><span class="mf">3.3</span><span class="p">,</span>  <span class="mf">3.4</span><span class="p">,</span>  <span class="mf">3.5</span><span class="p">,</span>  <span class="mf">3.6</span><span class="p">,</span>  <span class="mf">3.7</span><span class="p">,</span>  <span class="mf">3.8</span><span class="p">,</span>  <span class="mf">3.9</span><span class="p">,</span>  <span class="mf">4.</span> <span class="p">,</span>  <span class="mf">4.1</span><span class="p">,</span>  <span class="mf">4.2</span><span class="p">,</span>  <span class="mf">4.3</span><span class="p">,</span><span class="mf">4.4</span><span class="p">,</span>  <span class="mf">4.5</span><span class="p">,</span>  <span class="mf">4.6</span><span class="p">,</span>  <span class="mf">4.7</span><span class="p">,</span>  <span class="mf">4.8</span><span class="p">,</span>  <span class="mf">4.9</span><span class="p">,</span>  <span class="mf">5.</span> <span class="p">,</span>  <span class="mf">5.1</span><span class="p">,</span>  <span class="mf">5.2</span><span class="p">,</span>  <span class="mf">5.3</span><span class="p">,</span>  <span class="mf">5.4</span><span class="p">,</span><span class="mf">5.5</span><span class="p">,</span>  <span class="mf">5.6</span><span class="p">,</span>  <span class="mf">5.7</span><span class="p">,</span>  <span class="mf">5.8</span><span class="p">,</span>  <span class="mf">5.9</span><span class="p">,</span>  <span class="mf">6.</span> <span class="p">,</span>  <span class="mf">6.1</span><span class="p">,</span>  <span class="mf">6.2</span><span class="p">,</span>  <span class="mf">6.3</span><span class="p">,</span>  <span class="mf">6.4</span><span class="p">,</span>  <span class="mf">6.5</span><span class="p">,</span><span class="mf">6.6</span><span class="p">,</span>  <span class="mf">6.7</span><span class="p">,</span>  <span class="mf">6.8</span><span class="p">,</span>  <span class="mf">6.9</span><span class="p">,</span>  <span class="mf">7.</span> <span class="p">,</span>  <span class="mf">7.1</span><span class="p">,</span>  <span class="mf">7.2</span><span class="p">,</span>  <span class="mf">7.3</span><span class="p">,</span>  <span class="mf">7.4</span><span class="p">,</span>  <span class="mf">7.5</span><span class="p">,</span>  <span class="mf">7.6</span><span class="p">,</span><span class="mf">7.7</span><span class="p">,</span>  <span class="mf">7.8</span><span class="p">,</span>  <span class="mf">7.9</span><span class="p">,</span>  <span class="mf">8.</span> <span class="p">,</span>  <span class="mf">8.1</span><span class="p">,</span>  <span class="mf">8.2</span><span class="p">,</span>  <span class="mf">8.3</span><span class="p">,</span>  <span class="mf">8.4</span><span class="p">,</span>  <span class="mf">8.5</span><span class="p">,</span>  <span class="mf">8.6</span><span class="p">,</span>  <span class="mf">8.7</span><span class="p">,</span><span class="mf">8.8</span><span class="p">,</span>  <span class="mf">8.9</span><span class="p">,</span>  <span class="mf">9.</span> <span class="p">,</span>  <span class="mf">9.1</span><span class="p">,</span>  <span class="mf">9.2</span><span class="p">,</span>  <span class="mf">9.3</span><span class="p">,</span>  <span class="mf">9.4</span><span class="p">,</span>  <span class="mf">9.5</span><span class="p">,</span>  <span class="mf">9.6</span><span class="p">,</span>  <span class="mf">9.7</span><span class="p">,</span>  <span class="mf">9.8</span><span class="p">,</span><span class="mf">9.9</span><span class="p">,</span> <span class="mf">10.</span> <span class="p">,</span> <span class="mf">10.1</span><span class="p">,</span> <span class="mf">10.2</span><span class="p">,</span> <span class="mf">10.3</span><span class="p">,</span> <span class="mf">10.4</span><span class="p">,</span> <span class="mf">10.5</span><span class="p">,</span> <span class="mf">10.6</span><span class="p">,</span> <span class="mf">10.7</span><span class="p">,</span> <span class="mf">10.8</span><span class="p">,</span> <span class="mf">10.9</span><span class="p">,</span><span class="mf">11.</span> <span class="p">,</span> <span class="mf">11.1</span><span class="p">,</span> <span class="mf">11.2</span><span class="p">,</span> <span class="mf">11.3</span><span class="p">,</span> <span class="mf">11.4</span><span class="p">,</span> <span class="mf">11.5</span><span class="p">,</span> <span class="mf">11.6</span><span class="p">,</span> <span class="mf">11.7</span><span class="p">,</span> <span class="mf">11.8</span><span class="p">,</span> <span class="mf">11.9</span><span class="p">,</span> <span class="mf">12.</span> <span class="p">,</span><span class="mf">12.1</span><span class="p">,</span> <span class="mf">12.2</span><span class="p">,</span> <span class="mf">12.3</span><span class="p">,</span> <span class="mf">12.4</span><span class="p">,</span> <span class="mf">12.5</span><span class="p">,</span> <span class="mf">12.6</span><span class="p">,</span> <span class="mf">12.7</span><span class="p">,</span> <span class="mf">12.8</span><span class="p">,</span> <span class="mf">12.9</span><span class="p">,</span> <span class="mf">13.</span> <span class="p">,</span> <span class="mf">13.1</span><span class="p">,</span><span class="mf">13.2</span><span class="p">,</span> <span class="mf">13.3</span><span class="p">,</span> <span class="mf">13.4</span><span class="p">,</span> <span class="mf">13.5</span><span class="p">,</span> <span class="mf">13.6</span><span class="p">,</span> <span class="mf">13.7</span><span class="p">,</span> <span class="mf">13.8</span><span class="p">,</span> <span class="mf">13.9</span><span class="p">,</span> <span class="mf">14.</span> <span class="p">,</span> <span class="mf">14.1</span><span class="p">,</span> <span class="mf">14.2</span><span class="p">,</span><span class="mf">14.3</span><span class="p">,</span> <span class="mf">14.4</span><span class="p">,</span> <span class="mf">14.5</span><span class="p">,</span> <span class="mf">14.6</span><span class="p">,</span> <span class="mf">14.7</span><span class="p">,</span> <span class="mf">14.8</span><span class="p">,</span> <span class="mf">14.9</span><span class="p">,</span> <span class="mf">15.</span> <span class="p">,</span> <span class="mf">15.1</span><span class="p">,</span> <span class="mf">15.2</span><span class="p">,</span> <span class="mf">15.3</span><span class="p">,</span><span class="mf">15.4</span><span class="p">,</span> <span class="mf">15.5</span><span class="p">,</span> <span class="mf">15.6</span><span class="p">,</span> <span class="mf">15.7</span><span class="p">,</span> <span class="mf">15.8</span><span class="p">,</span> <span class="mf">15.9</span><span class="p">,</span> <span class="mf">16.</span> <span class="p">,</span> <span class="mf">16.1</span><span class="p">,</span> <span class="mf">16.2</span><span class="p">,</span> <span class="mf">16.3</span><span class="p">,</span> <span class="mf">16.4</span><span class="p">,</span><span class="mf">16.5</span><span class="p">,</span> <span class="mf">16.6</span><span class="p">,</span> <span class="mf">16.7</span><span class="p">,</span> <span class="mf">16.8</span><span class="p">,</span> <span class="mf">16.9</span><span class="p">,</span> <span class="mf">17.</span> <span class="p">,</span> <span class="mf">17.1</span><span class="p">,</span> <span class="mf">17.2</span><span class="p">,</span> <span class="mf">17.3</span><span class="p">,</span> <span class="mf">17.4</span><span class="p">,</span> <span class="mf">17.5</span><span class="p">,</span><span class="mf">17.6</span><span class="p">,</span> <span class="mf">17.7</span><span class="p">,</span> <span class="mf">17.8</span><span class="p">,</span> <span class="mf">17.9</span><span class="p">,</span> <span class="mf">18.</span> <span class="p">,</span> <span class="mf">18.1</span><span class="p">,</span> <span class="mf">18.2</span><span class="p">,</span> <span class="mf">18.3</span><span class="p">,</span> <span class="mf">18.4</span><span class="p">,</span> <span class="mf">18.5</span><span class="p">,</span> <span class="mf">18.6</span><span class="p">,</span><span class="mf">18.7</span><span class="p">,</span> <span class="mf">18.8</span><span class="p">,</span> <span class="mf">18.9</span><span class="p">,</span> <span class="mf">19.</span> <span class="p">,</span> <span class="mf">19.1</span><span class="p">,</span> <span class="mf">19.2</span><span class="p">,</span> <span class="mf">19.3</span><span class="p">,</span> <span class="mf">19.4</span><span class="p">,</span> <span class="mf">19.5</span><span class="p">,</span> <span class="mf">19.6</span><span class="p">,</span> <span class="mf">19.7</span><span class="p">,</span><span class="mf">19.8</span><span class="p">,</span> <span class="mf">19.9</span><span class="p">]))</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>constant drift function</p>
<h5 id="ssms.basic_simulators.drift_functions.constant--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>t (_type_, optional): _description_. Defaults to np.arange(0, 20, 0.1).
</code></pre></div>
<h5 id="ssms.basic_simulators.drift_functions.constant--returns">Returns</h5>
<div class="language-text highlight"><pre><span></span><code>np.array: Array of drift values, same length as t
</code></pre></div>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.drift_functions.ds_conflict_drift" class="doc doc-heading">
<code class="highlight language-python"><span class="n">ds_conflict_drift</span><span class="p">(</span><span class="n">t</span><span class="o">=</span><span class="n">array</span><span class="p">([</span><span class="mf">0.000e+00</span><span class="p">,</span> <span class="mf">1.000e-03</span><span class="p">,</span> <span class="mf">2.000e-03</span><span class="p">,</span> <span class="o">...</span><span class="p">,</span> <span class="mf">9.997e+00</span><span class="p">,</span> <span class="mf">9.998e+00</span><span class="p">,</span><span class="mf">9.999e+00</span><span class="p">]),</span> <span class="n">init_p_t</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">init_p_d</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">slope_t</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">slope_d</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">fixed_p_t</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">coherence_t</span><span class="o">=</span><span class="mf">1.5</span><span class="p">,</span> <span class="n">coherence_d</span><span class="o">=</span><span class="mf">1.5</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>This drift is inspired by a conflict task which
   involves a target and a distractor stimuli both presented
   simultaneously.
   Two drift timecourses are linearly combined weighted
   by the coherence in the respective target and distractor stimuli.
   Each timecourse follows a dynamical system as described
   in the ds_support_analytic() function.</p>
<h5 id="ssms.basic_simulators.drift_functions.ds_conflict_drift--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>!!! t &quot;np.ndarray &lt;default=np.arange(0, 20, 0.1)&gt;&quot;
    Timepoints at which to evaluate the drift.
    Usually np.arange() of some sort.
!!! init_p_t &quot;float &lt;default=0&gt;&quot;
    Initial condition of target drift timecourse
!!! init_p_d &quot;float &lt;default=0&gt;&quot;
    Initial condition of distractor drift timecourse
!!! slope_t &quot;float &lt;default=1&gt;&quot;
    Slope parameter for target drift timecourse
!!! slope_d &quot;float &lt;default=1&gt;&quot;
    Slope parameter for distractor drift timecourse
!!! fixed_p_t &quot;float &lt;default=1&gt;&quot;
    Fixed point for target drift timecourse
!!! coherence_t &quot;float &lt;default=1.0&gt;&quot;
    Coefficient for the target drift timecourse
!!! coherence_d &quot;float &lt;default=-1.0&gt;&quot;
    Coefficient for the distractor drift timecourse
</code></pre></div>
<h5 id="ssms.basic_simulators.drift_functions.ds_conflict_drift--return">Return</h5>
<p>np.ndarray
     The full drift timecourse evaluated at the supplied timepoints t.</p>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.drift_functions.ds_support_analytic" class="doc doc-heading">
<code class="highlight language-python"><span class="n">ds_support_analytic</span><span class="p">(</span><span class="n">t</span><span class="o">=</span><span class="n">array</span><span class="p">([</span><span class="mf">0.000e+00</span><span class="p">,</span> <span class="mf">1.000e-03</span><span class="p">,</span> <span class="mf">2.000e-03</span><span class="p">,</span> <span class="o">...</span><span class="p">,</span> <span class="mf">9.997e+00</span><span class="p">,</span> <span class="mf">9.998e+00</span><span class="p">,</span><span class="mf">9.999e+00</span><span class="p">]),</span> <span class="n">init_p</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">fix_point</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">slope</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>Solution to differential equation of the form:
   x' = slope*(fix_point - x),
   with initial condition init_p.
   The solution takes the form:
   (init_p - fix_point) * exp(-slope * t) + fix_point</p>
<h5 id="ssms.basic_simulators.drift_functions.ds_support_analytic--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>!!! t &quot;np.ndarray &lt;default=np.arange(0, 20, 0.1)&gt;&quot;
    Timepoints at which to evaluate the drift. Usually np.arange() of some sort.
!!! init_p &quot;float &lt;default=0&gt;&quot;
    Initial condition of dynamical system
!!! fix_point &quot;float &lt;default=1&gt;&quot;
    Fixed point of dynamical system
!!! slope &quot;float &lt;default=0.01&gt;&quot;
    Coefficient in exponent of the solution.
</code></pre></div>
<h5 id="ssms.basic_simulators.drift_functions.ds_support_analytic--return">Return</h5>
<p>np.ndarray
     The gamma drift evaluated at the supplied timepoints t.</p>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.drift_functions.gamma_drift" class="doc doc-heading">
<code class="highlight language-python"><span class="n">gamma_drift</span><span class="p">(</span><span class="n">t</span><span class="o">=</span><span class="n">array</span><span class="p">([</span> <span class="mf">0.</span> <span class="p">,</span>  <span class="mf">0.1</span><span class="p">,</span>  <span class="mf">0.2</span><span class="p">,</span>  <span class="mf">0.3</span><span class="p">,</span>  <span class="mf">0.4</span><span class="p">,</span>  <span class="mf">0.5</span><span class="p">,</span>  <span class="mf">0.6</span><span class="p">,</span>  <span class="mf">0.7</span><span class="p">,</span>  <span class="mf">0.8</span><span class="p">,</span>  <span class="mf">0.9</span><span class="p">,</span>  <span class="mf">1.</span> <span class="p">,</span><span class="mf">1.1</span><span class="p">,</span>  <span class="mf">1.2</span><span class="p">,</span>  <span class="mf">1.3</span><span class="p">,</span>  <span class="mf">1.4</span><span class="p">,</span>  <span class="mf">1.5</span><span class="p">,</span>  <span class="mf">1.6</span><span class="p">,</span>  <span class="mf">1.7</span><span class="p">,</span>  <span class="mf">1.8</span><span class="p">,</span>  <span class="mf">1.9</span><span class="p">,</span>  <span class="mf">2.</span> <span class="p">,</span>  <span class="mf">2.1</span><span class="p">,</span><span class="mf">2.2</span><span class="p">,</span>  <span class="mf">2.3</span><span class="p">,</span>  <span class="mf">2.4</span><span class="p">,</span>  <span class="mf">2.5</span><span class="p">,</span>  <span class="mf">2.6</span><span class="p">,</span>  <span class="mf">2.7</span><span class="p">,</span>  <span class="mf">2.8</span><span class="p">,</span>  <span class="mf">2.9</span><span class="p">,</span>  <span class="mf">3.</span> <span class="p">,</span>  <span class="mf">3.1</span><span class="p">,</span>  <span class="mf">3.2</span><span class="p">,</span><span class="mf">3.3</span><span class="p">,</span>  <span class="mf">3.4</span><span class="p">,</span>  <span class="mf">3.5</span><span class="p">,</span>  <span class="mf">3.6</span><span class="p">,</span>  <span class="mf">3.7</span><span class="p">,</span>  <span class="mf">3.8</span><span class="p">,</span>  <span class="mf">3.9</span><span class="p">,</span>  <span class="mf">4.</span> <span class="p">,</span>  <span class="mf">4.1</span><span class="p">,</span>  <span class="mf">4.2</span><span class="p">,</span>  <span class="mf">4.3</span><span class="p">,</span><span class="mf">4.4</span><span class="p">,</span>  <span class="mf">4.5</span><span class="p">,</span>  <span class="mf">4.6</span><span class="p">,</span>  <span class="mf">4.7</span><span class="p">,</span>  <span class="mf">4.8</span><span class="p">,</span>  <span class="mf">4.9</span><span class="p">,</span>  <span class="mf">5.</span> <span class="p">,</span>  <span class="mf">5.1</span><span class="p">,</span>  <span class="mf">5.2</span><span class="p">,</span>  <span class="mf">5.3</span><span class="p">,</span>  <span class="mf">5.4</span><span class="p">,</span><span class="mf">5.5</span><span class="p">,</span>  <span class="mf">5.6</span><span class="p">,</span>  <span class="mf">5.7</span><span class="p">,</span>  <span class="mf">5.8</span><span class="p">,</span>  <span class="mf">5.9</span><span class="p">,</span>  <span class="mf">6.</span> <span class="p">,</span>  <span class="mf">6.1</span><span class="p">,</span>  <span class="mf">6.2</span><span class="p">,</span>  <span class="mf">6.3</span><span class="p">,</span>  <span class="mf">6.4</span><span class="p">,</span>  <span class="mf">6.5</span><span class="p">,</span><span class="mf">6.6</span><span class="p">,</span>  <span class="mf">6.7</span><span class="p">,</span>  <span class="mf">6.8</span><span class="p">,</span>  <span class="mf">6.9</span><span class="p">,</span>  <span class="mf">7.</span> <span class="p">,</span>  <span class="mf">7.1</span><span class="p">,</span>  <span class="mf">7.2</span><span class="p">,</span>  <span class="mf">7.3</span><span class="p">,</span>  <span class="mf">7.4</span><span class="p">,</span>  <span class="mf">7.5</span><span class="p">,</span>  <span class="mf">7.6</span><span class="p">,</span><span class="mf">7.7</span><span class="p">,</span>  <span class="mf">7.8</span><span class="p">,</span>  <span class="mf">7.9</span><span class="p">,</span>  <span class="mf">8.</span> <span class="p">,</span>  <span class="mf">8.1</span><span class="p">,</span>  <span class="mf">8.2</span><span class="p">,</span>  <span class="mf">8.3</span><span class="p">,</span>  <span class="mf">8.4</span><span class="p">,</span>  <span class="mf">8.5</span><span class="p">,</span>  <span class="mf">8.6</span><span class="p">,</span>  <span class="mf">8.7</span><span class="p">,</span><span class="mf">8.8</span><span class="p">,</span>  <span class="mf">8.9</span><span class="p">,</span>  <span class="mf">9.</span> <span class="p">,</span>  <span class="mf">9.1</span><span class="p">,</span>  <span class="mf">9.2</span><span class="p">,</span>  <span class="mf">9.3</span><span class="p">,</span>  <span class="mf">9.4</span><span class="p">,</span>  <span class="mf">9.5</span><span class="p">,</span>  <span class="mf">9.6</span><span class="p">,</span>  <span class="mf">9.7</span><span class="p">,</span>  <span class="mf">9.8</span><span class="p">,</span><span class="mf">9.9</span><span class="p">,</span> <span class="mf">10.</span> <span class="p">,</span> <span class="mf">10.1</span><span class="p">,</span> <span class="mf">10.2</span><span class="p">,</span> <span class="mf">10.3</span><span class="p">,</span> <span class="mf">10.4</span><span class="p">,</span> <span class="mf">10.5</span><span class="p">,</span> <span class="mf">10.6</span><span class="p">,</span> <span class="mf">10.7</span><span class="p">,</span> <span class="mf">10.8</span><span class="p">,</span> <span class="mf">10.9</span><span class="p">,</span><span class="mf">11.</span> <span class="p">,</span> <span class="mf">11.1</span><span class="p">,</span> <span class="mf">11.2</span><span class="p">,</span> <span class="mf">11.3</span><span class="p">,</span> <span class="mf">11.4</span><span class="p">,</span> <span class="mf">11.5</span><span class="p">,</span> <span class="mf">11.6</span><span class="p">,</span> <span class="mf">11.7</span><span class="p">,</span> <span class="mf">11.8</span><span class="p">,</span> <span class="mf">11.9</span><span class="p">,</span> <span class="mf">12.</span> <span class="p">,</span><span class="mf">12.1</span><span class="p">,</span> <span class="mf">12.2</span><span class="p">,</span> <span class="mf">12.3</span><span class="p">,</span> <span class="mf">12.4</span><span class="p">,</span> <span class="mf">12.5</span><span class="p">,</span> <span class="mf">12.6</span><span class="p">,</span> <span class="mf">12.7</span><span class="p">,</span> <span class="mf">12.8</span><span class="p">,</span> <span class="mf">12.9</span><span class="p">,</span> <span class="mf">13.</span> <span class="p">,</span> <span class="mf">13.1</span><span class="p">,</span><span class="mf">13.2</span><span class="p">,</span> <span class="mf">13.3</span><span class="p">,</span> <span class="mf">13.4</span><span class="p">,</span> <span class="mf">13.5</span><span class="p">,</span> <span class="mf">13.6</span><span class="p">,</span> <span class="mf">13.7</span><span class="p">,</span> <span class="mf">13.8</span><span class="p">,</span> <span class="mf">13.9</span><span class="p">,</span> <span class="mf">14.</span> <span class="p">,</span> <span class="mf">14.1</span><span class="p">,</span> <span class="mf">14.2</span><span class="p">,</span><span class="mf">14.3</span><span class="p">,</span> <span class="mf">14.4</span><span class="p">,</span> <span class="mf">14.5</span><span class="p">,</span> <span class="mf">14.6</span><span class="p">,</span> <span class="mf">14.7</span><span class="p">,</span> <span class="mf">14.8</span><span class="p">,</span> <span class="mf">14.9</span><span class="p">,</span> <span class="mf">15.</span> <span class="p">,</span> <span class="mf">15.1</span><span class="p">,</span> <span class="mf">15.2</span><span class="p">,</span> <span class="mf">15.3</span><span class="p">,</span><span class="mf">15.4</span><span class="p">,</span> <span class="mf">15.5</span><span class="p">,</span> <span class="mf">15.6</span><span class="p">,</span> <span class="mf">15.7</span><span class="p">,</span> <span class="mf">15.8</span><span class="p">,</span> <span class="mf">15.9</span><span class="p">,</span> <span class="mf">16.</span> <span class="p">,</span> <span class="mf">16.1</span><span class="p">,</span> <span class="mf">16.2</span><span class="p">,</span> <span class="mf">16.3</span><span class="p">,</span> <span class="mf">16.4</span><span class="p">,</span><span class="mf">16.5</span><span class="p">,</span> <span class="mf">16.6</span><span class="p">,</span> <span class="mf">16.7</span><span class="p">,</span> <span class="mf">16.8</span><span class="p">,</span> <span class="mf">16.9</span><span class="p">,</span> <span class="mf">17.</span> <span class="p">,</span> <span class="mf">17.1</span><span class="p">,</span> <span class="mf">17.2</span><span class="p">,</span> <span class="mf">17.3</span><span class="p">,</span> <span class="mf">17.4</span><span class="p">,</span> <span class="mf">17.5</span><span class="p">,</span><span class="mf">17.6</span><span class="p">,</span> <span class="mf">17.7</span><span class="p">,</span> <span class="mf">17.8</span><span class="p">,</span> <span class="mf">17.9</span><span class="p">,</span> <span class="mf">18.</span> <span class="p">,</span> <span class="mf">18.1</span><span class="p">,</span> <span class="mf">18.2</span><span class="p">,</span> <span class="mf">18.3</span><span class="p">,</span> <span class="mf">18.4</span><span class="p">,</span> <span class="mf">18.5</span><span class="p">,</span> <span class="mf">18.6</span><span class="p">,</span><span class="mf">18.7</span><span class="p">,</span> <span class="mf">18.8</span><span class="p">,</span> <span class="mf">18.9</span><span class="p">,</span> <span class="mf">19.</span> <span class="p">,</span> <span class="mf">19.1</span><span class="p">,</span> <span class="mf">19.2</span><span class="p">,</span> <span class="mf">19.3</span><span class="p">,</span> <span class="mf">19.4</span><span class="p">,</span> <span class="mf">19.5</span><span class="p">,</span> <span class="mf">19.6</span><span class="p">,</span> <span class="mf">19.7</span><span class="p">,</span><span class="mf">19.8</span><span class="p">,</span> <span class="mf">19.9</span><span class="p">]),</span> <span class="n">shape</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mf">0.01</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="mf">1.5</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>Drift function that follows a scaled gamma distribution</p>
<h5 id="ssms.basic_simulators.drift_functions.gamma_drift--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>!!! t &quot;np.ndarray &lt;default=np.arange(0, 20, 0.1)&gt;&quot;
    Timepoints at which to evaluate the drift.
    Usually np.arange() of some sort.
!!! shape &quot;float &lt;default=2&gt;&quot;
    Shape parameter of the gamma distribution
!!! scale &quot;float &lt;default=0.01&gt;&quot;
    Scale parameter of the gamma distribution
!!! c &quot;float &lt;default=1.5&gt;&quot;
    Scalar parameter that scales the peak of
    the gamma distribution.
    (Note this function follows a gamma distribution
    but does not integrate to 1)
</code></pre></div>
<h5 id="ssms.basic_simulators.drift_functions.gamma_drift--return">Return</h5>
<div class="language-text highlight"><pre><span></span><code>np.ndarray
    The gamma drift evaluated at the supplied timepoints t.
</code></pre></div>

    </div>

  </div>





  </div>

    </div>

  </div>





  <div class="doc doc-object doc-module">



<h2 id="ssms.basic_simulators.simulator" class="doc doc-heading">
        <code>simulator</code>



</h2>

    <div class="doc doc-contents ">




  <div class="doc doc-children">




  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.simulator.bin_arbitrary_fptd" class="doc doc-heading">
<code class="highlight language-python"><span class="n">bin_arbitrary_fptd</span><span class="p">(</span><span class="n">out</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">bin_dt</span><span class="o">=</span><span class="mf">0.04</span><span class="p">,</span> <span class="n">nbins</span><span class="o">=</span><span class="mi">256</span><span class="p">,</span> <span class="n">nchoices</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">choice_codes</span><span class="o">=</span><span class="p">[</span><span class="o">-</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <span class="n">max_t</span><span class="o">=</span><span class="mf">10.0</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>Takes in simulator output and returns a histogram of bin counts
Arguments</p>
<hr />
<div class="language-text highlight"><pre><span></span><code>!!! out &quot;tuple&quot;
    Output of the &#39;simulator&#39; function
bin_dt : float
    If nbins is 0, this determines the desired bin size
    which in turn automatically determines the resulting number of bins.
nbins : int
    Number of bins to bin reaction time data into.
    If supplied as 0, bin_dt instead determines the number of
    bins automatically.
!!! nchoices &quot;int &lt;default=2&gt;&quot;
    Number of choices allowed by the simulator.
choice_codes = list &lt;default=[-1.0, 1.0]
    Choice labels to be used.
!!! max_t &quot;float&quot;
    Maximum RT to consider.
</code></pre></div>
<h5 id="ssms.basic_simulators.simulator.bin_arbitrary_fptd--returns">Returns</h5>
<div class="language-text highlight"><pre><span></span><code>2d array (nbins, nchoices): A histogram of bin counts
</code></pre></div>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.simulator.bin_simulator_output" class="doc doc-heading">
<code class="highlight language-python"><span class="n">bin_simulator_output</span><span class="p">(</span><span class="n">out</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">bin_dt</span><span class="o">=</span><span class="mf">0.04</span><span class="p">,</span> <span class="n">nbins</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">max_t</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">freq_cnt</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>Turns RT part of simulator output into bin-identifier by trial</p>
<h5 id="ssms.basic_simulators.simulator.bin_simulator_output--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>out : tuple
    Output of the &#39;simulator&#39; function
bin_dt : float
    If nbins is 0, this determines the desired
    bin size which in turn automatically
    determines the resulting number of bins.
nbins : int
    Number of bins to bin reaction time data into.
    If supplied as 0, bin_dt instead determines the number of
    bins automatically.
max_t : int &lt;default=-1&gt;
    Override the &#39;max_t&#39; metadata as part of the simulator output.
    Sometimes useful, but usually default will do the job.
freq_cnt : bool &lt;default=False&gt;
    Decide whether to return proportions (default) or counts in bins.
</code></pre></div>
<h5 id="ssms.basic_simulators.simulator.bin_simulator_output--returns">Returns</h5>
<div class="language-text highlight"><pre><span></span><code>A histogram of counts or proportions.
</code></pre></div>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.simulator.bin_simulator_output_pointwise" class="doc doc-heading">
<code class="highlight language-python"><span class="n">bin_simulator_output_pointwise</span><span class="p">(</span><span class="n">out</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">bin_dt</span><span class="o">=</span><span class="mf">0.04</span><span class="p">,</span> <span class="n">nbins</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>Turns RT part of simulator output into bin-identifier by trial</p>
<h5 id="ssms.basic_simulators.simulator.bin_simulator_output_pointwise--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>!!! out &quot;tuple&quot;
    Output of the &#39;simulator&#39; function
!!! bin_dt &quot;float&quot;
    If nbins is 0, this determines the desired
    bin size which in turn automatically
    determines the resulting number of bins.
!!! nbins &quot;int&quot;
    Number of bins to bin reaction time data into.
    If supplied as 0, bin_dt instead determines the
    number of bins automatically.
</code></pre></div>
<h5 id="ssms.basic_simulators.simulator.bin_simulator_output_pointwise--returns">Returns</h5>
<div class="language-text highlight"><pre><span></span><code>2d array. The first columns collects bin-identifiers
by trial, the second column lists the corresponding choices.
</code></pre></div>

    </div>

  </div>





  <div class="doc doc-object doc-function">



<h3 id="ssms.basic_simulators.simulator.simulator" class="doc doc-heading">
<code class="highlight language-python"><span class="n">simulator</span><span class="p">(</span><span class="n">theta</span><span class="p">,</span> <span class="n">model</span><span class="o">=</span><span class="s1">&#39;angle&#39;</span><span class="p">,</span> <span class="n">n_samples</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span> <span class="n">delta_t</span><span class="o">=</span><span class="mf">0.001</span><span class="p">,</span> <span class="n">max_t</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">no_noise</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">bin_dim</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">bin_pointwise</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">smooth_unif</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">random_state</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>


</h3>

    <div class="doc doc-contents ">

      <p>Basic data simulator for the models included in HDDM.</p>
<h5 id="ssms.basic_simulators.simulator.simulator--arguments">Arguments</h5>
<div class="language-text highlight"><pre><span></span><code>theta : list, numpy.array, dict or pd.DataFrame
    Parameters of the simulator. If 2d array, each row is treated as a &#39;trial&#39;
    and the function runs n_sample * n_trials simulations.
!!! model &quot;str &lt;default=&#39;angle&#39;&gt;&quot;
    Determines the model that will be simulated.
!!! n_samples &quot;int &lt;default=1000&gt;&quot;
    Number of simulation runs for each row in the theta argument.
!!! delta_t &quot;float&quot;
    Size fo timesteps in simulator (conceptually measured in seconds)
!!! max_t &quot;float&quot;
    Maximum reaction the simulator can reach
!!! no_noise &quot;bool &lt;default=False&gt;&quot;
    Turn noise of (useful for plotting purposes mostly)
!!! bin_dim &quot;int &lt;default=None&gt;&quot;
    Number of bins to use (in case the simulator output is
    supposed to come out as a count histogram)
!!! bin_pointwise &quot;bool &lt;default=False&gt;&quot;
    Wheter or not to bin the output data pointwise.
    If true the &#39;RT&#39; part of the data is now specifies the
    &#39;bin-number&#39; of a given trial instead of the &#39;RT&#39; directly.
    You need to specify bin_dim as some number for this to work.
!!! random_state &quot;int &lt;default=None&gt;&quot;
    Integer passed to random_seed function in the simulator.
    Can be used for reproducibility.
</code></pre></div>
<h5 id="ssms.basic_simulators.simulator.simulator--return">Return</h5>
<p>dictionary where keys
    can be (rts, responses, metadata)
    or     (rt-response histogram, metadata)
    or     (rts binned pointwise, responses, metadata)</p>

    </div>

  </div>





  </div>

    </div>

  </div>





  </div>

    </div>

  </div>












                
              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
    
    <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.path", "navigation.top", "content.code.copy", "content.action.view", "content.action.edit", "header.autohide", "announce.dismiss"], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
    
    
      <script src="../../assets/javascripts/bundle.d7c377c4.min.js"></script>
      
    
  </body>
</html>